Skip to content

Re-enable Forge Formatting Check in CI#37

Merged
mudgen merged 3 commits into
Perfect-Abstractions:mainfrom
adamgall:fix/check-fmt
Oct 22, 2025
Merged

Re-enable Forge Formatting Check in CI#37
mudgen merged 3 commits into
Perfect-Abstractions:mainfrom
adamgall:fix/check-fmt

Conversation

@adamgall

@adamgall adamgall commented Oct 20, 2025

Copy link
Copy Markdown
Collaborator

Summary

This PR re-enables the forge fmt --check step in the GitHub Actions workflow that was previously commented out.

Context

The Forge formatting check was temporarily disabled in a previous commit to unblock CI. After fixing formatting issues in the codebase (commit df942e7), we can now safely re-enable this check to maintain code formatting standards going forward.

Changes

  • Uncommented the Run Forge fmt step in .github/workflows/test.yml
  • This will now enforce consistent Solidity code formatting on all PRs

Testing

  • CI should pass with the formatting check enabled
  • All existing tests should continue to pass

Impact

This ensures that all future code contributions maintain consistent formatting standards, improving code readability and reducing formatting-related conflicts in PRs.

Related Issue

Closes #36

@mudgen

mudgen commented Oct 20, 2025

Copy link
Copy Markdown
Contributor

I agree with this. But first I need to provide better contributor documentation to people adding code know that they need to pass forge fmt --check before submitting a merge request so I don't reject it for that reason. I will add that documentation. Thanks for making this pull request and I'll merge it later.

@adamgall

adamgall commented Oct 20, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

I'll just push up that documentation in this PR. Gimme a min.

edit: all done @mudgen

maxnorm
maxnorm reviewed Oct 21, 2025
View reviewed changes

@maxnorm maxnorm left a comment •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before stuffing contribution requirements inside the README, we can add a CONTRIBUTION.md file with all the related infos like your change.

This can have it's own issue if needed

@maxnorm

maxnorm commented Oct 21, 2025

Copy link
Copy Markdown
Collaborator

Hi @adamgall, i've created a new CONTRIBUTING.md file to keep all the requirements in 1 file and avoid complicating the README with the contribution infos.

Can you resolve conflicts and add you formatting doc in the CONTRIBUTING.md where it feel the more natural.

We mention it in the Dev Workflow at line 75 but feel free to add a new section if needed

Thanks

@adamgall

adamgall commented Oct 21, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

@maxnorm i fixed the merge conflicts, but it looks like the github action has failed. seems like all of the jobs are failing since this commit: 69cd70a

@mudgen

mudgen commented Oct 22, 2025

Copy link
Copy Markdown
Contributor

I fixed the github action. Merging this.

@mudgen mudgen merged commit 0882021 into Perfect-Abstractions:main Oct 22, 2025
1 check failed
@adamgall adamgall deleted the fix/check-fmt branch October 22, 2025 01:51
JackieXu pushed a commit to JackieXu/Compose that referenced this pull request Nov 6, 2025
@mudgen
Merge pull request Perfect-Abstractions#37 from adamgall/fix/check-fmt
a351f47 
Re-enable Forge Formatting Check in CI
maxnorm added a commit that referenced this pull request Mar 25, 2026
@maxnorm
Merge pull request #37 from maxnorm/docs/auto-generated-34
cd8dfae 
[DOCS] Auto-generated Docs Pages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maxnorm maxnorm maxnorm left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Re-enable Forge Formatting Check in CI

3 participants

@adamgall @mudgen @maxnorm